AI Model Inference (preview:2024-05-01)

2025/04/08 • 1 updated methods

GetModelInfo (updated)
Description :  Returns information about the AI model deployed. The method makes a REST API call to the `/info` route on the given endpoint. This method will only work when using Serverless API, Managed Compute, or Model . inference endpoint. Azure OpenAI endpoints don't support i.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetModelInfo",
  "Description": {
    "new": "Returns information about the AI model deployed.\nThe method makes a REST API call to the `/info` route on the given endpoint.\nThis method will only work when using Serverless API, Managed Compute, or Model .\ninference endpoint. Azure OpenAI endpoints don't support i.",
    "old": "Returns information about the AI model.\nThe method makes a REST API call to the `/info` route on the given endpoint.\nThis method will only work when using Serverless API or Managed Compute endpoint.\nIt will not work for GitHub Models endpoint or Azure OpenAI endpoint."
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "model_provider_name",
          "Description": {
            "new": "The model provider name. For example: `Microsoft`",
            "old": "The model provider name. For example: `Microsoft Research`"
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /info
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
model_name:
{
Description: The name of the AI model. For example: `Phi21` ,
Required: True ,
}
string ,
model_type:
{
Description: The type of the AI model. A Unique identifier for the profile. ,
Enum:
{
embeddings: A model capable of generating embeddings from a text ,
chat-completion: A model capable of taking chat-formatted messages and generate responses ,
}
,
Required: True ,
}
enum ,
model_provider_name:
{
Description: The model provider name. For example: `Microsoft` ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}